Skip to content

docs(readme): use DAQiFi brand capitalization in prose contexts#218

Merged
tylerkron merged 1 commit into
mainfrom
docs/readme-title-brand-alignment
May 22, 2026
Merged

docs(readme): use DAQiFi brand capitalization in prose contexts#218
tylerkron merged 1 commit into
mainfrom
docs/readme-title-brand-alignment

Conversation

@tylerkron
Copy link
Copy Markdown
Contributor

@tylerkron tylerkron commented May 22, 2026

Summary

The recent README rewrite (#215) used the NuGet package identifier Daqifi.Core as a brand-style product name in prose contexts. Per DAQiFi marketing guidelines (verified against daqifi.com), the brand is DAQiFi — so prose references to the product should be DAQiFi Core, matching the DAQiFi {ProductName} pattern already used by daqifi-desktop (# DAQiFi Desktop).

Changed (prose contexts)

  • Title: # Daqifi.Core# DAQiFi Core
  • Heading: ## What is Daqifi.Core?## What is DAQiFi Core?
  • Body: **Daqifi.Core is how you integrate...****DAQiFi Core is how you integrate...**
  • Heading: ## Where Daqifi.Core fits## Where DAQiFi Core fits
  • Table cell: **Daqifi.Core — this library****DAQiFi Core — this library**

Unchanged (code / package / badge contexts)

  • NuGet badges (literal package name in URLs)
  • dotnet add package Daqifi.Core (literal package name)
  • using Daqifi.Core.Device; and other C# namespaces
  • DaqifiDeviceFactory, DaqifiOutMessage class names

These follow .NET identifier conventions, not marketing style — the mixed-case DAQiFi brand form isn't legal/idiomatic in C# identifiers.

Test plan

  • GitHub renders the README with # DAQiFi Core heading.
  • No prose-context Daqifi.Core references remain — only badges, shell commands, and C# code. (grep -n "Daqifi" README.md should show only those.)
  • NuGet badges still resolve to the correct package.

🤖 Generated with Claude Code

@tylerkron tylerkron requested a review from a team as a code owner May 22, 2026 14:07
@qodo-code-review
Copy link
Copy Markdown

Review Summary by Qodo

Align README title with DAQiFi product naming pattern

📝 Documentation

Grey Divider

Walkthroughs

Description
• Rename README title from "DAQiFi Core Library" to "DAQiFi Core"
• Align with DAQiFi product naming pattern used across ecosystem
• Remove redundant "Library" suffix from lead sentence
Diagram
flowchart LR
  old["DAQiFi Core Library"]
  new["DAQiFi Core"]
  pattern["DAQiFi {ProductName} pattern"]
  old -- "rename to match" --> new
  pattern -- "aligns with" --> new

Loading

File Changes

1. README.md 📝 Documentation +2/-2

Standardize README title to match product naming

• Changed main heading from "# DAQiFi Core Library" to "# DAQiFi Core"
• Updated lead sentence to remove "Library" suffix for consistency
• Maintains all other documentation content unchanged

README.md


Grey Divider

Qodo Logo

@qodo-code-review
Copy link
Copy Markdown

qodo-code-review Bot commented May 22, 2026

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Qodo Logo

The recent README rewrite (#215) used the NuGet package identifier
"Daqifi.Core" as a brand-style product name in prose contexts (title,
section headings, body copy, table cell). Per DAQiFi marketing
guidelines, prose references to the brand should use "DAQiFi", so
those marketing-facing occurrences become "DAQiFi Core" — matching
the "DAQiFi {ProductName}" pattern used by daqifi-desktop.

Code and badge contexts that reference the literal NuGet package or
C# namespace (Daqifi.Core in badges, `dotnet add package Daqifi.Core`,
`using Daqifi.Core.Device;`, DaqifiDeviceFactory, etc.) are
unchanged — those follow .NET identifier conventions, not marketing
style.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@tylerkron tylerkron force-pushed the docs/readme-title-brand-alignment branch from c05a530 to 3c41329 Compare May 22, 2026 14:14
@tylerkron tylerkron changed the title docs(readme): align title with DAQiFi product naming pattern docs(readme): use DAQiFi brand capitalization in prose contexts May 22, 2026
@tylerkron tylerkron merged commit 20a60e6 into main May 22, 2026
1 check passed
@tylerkron tylerkron deleted the docs/readme-title-brand-alignment branch May 22, 2026 14:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant